/*
 * Copyright (c) 2002 David Corbin and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Common Public License v0.5
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v05.html
 * 
 * Contributors:
 * 	  David Corbin - "best-practice" enum the describes the relationship
 * 						between a local folder and a perforce view.
 *    Boris Pruessmann - clean up
 */
package net.sourceforge.perforce.core.internal.api;

/**
  * @version $Revision: 18 $
  * @author  <a href="mailto:dcorbin@users.sourceforge.net">David Corbin</a>
  * @author  <a href="mailto:bpruessmann@users.sourceforge.net">Boris Pruessmann</a>
  */
public class FolderRepositoryRelation
{
	// ---------------------------------------------------------------------------- Public Constants
	
	/** Constant indicating a folder position within the perforce depot. */
	public static final FolderRepositoryRelation IN_REPOSITORY = 
		new FolderRepositoryRelation("Project exists in Repository");
	
	/** Constant indicating a folder position within the client's view. */
	public static final FolderRepositoryRelation IN_VIEW = 
		new FolderRepositoryRelation("Project is in view");
		
	/** Constant indicating a folder position under the client root but outside the client's
	  * view. */
	public static final FolderRepositoryRelation UNDER_ROOT = 
		new FolderRepositoryRelation("Project is under client root, but not in view");
		
	/** Constant indicating a position outside the client root. */
	public static final FolderRepositoryRelation OUTSIDE_ROOT = 
		new FolderRepositoryRelation("Project is outside of the client root");

	// --------------------------------------------------------------------------- Private Variables
	
	/** Stores the description. */
	private String desc;
	
	// ------------------------------------------------------------------------ Private Constructors
	
	/** Constructor for FolderRepositoryRelation. 
	  * 
	  * @param desc the description.
	  */
	private FolderRepositoryRelation(String desc)
	{ 
		this.desc = desc; 
	}
	
	/** @see Object#toString() */
	public String toString() 
	{ 
		return desc; 
	}
}	
